[workspace-hack] use workspace-dotted format and a patch directive #4197
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Created using spr 1.3.4
smklein
approved these changes
Oct 4, 2023
sunshowers
deleted the
sunshowers/spr/workspace-hack-use-workspace-dotted-format-and-a-patch-directive
branch
sunshowers
added a commit
to oxidecomputer/crucible
that referenced
this pull request
Oct 4, 2023
) Similar to oxidecomputer/omicron#4197, this PR has two changes: 1. Switch to the workspace-dotted format (`.workspace = true`) for uniformity with the rest of crucible. This is new in cargo-hakari 0.9.28. 2. Use a patch directive, which means that the workspace-hack only applies while building within this workspace. If another workspace imports a crate from here via a git dependency, it will not have the workspace-hack applied to it (instead, it will use [this empty crate](https://crates.io/crates/crucible-workspace-hack) on crates.io). Thanks so much to @pfmooney for this suggestion!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Two changes:
Switch to the workspace-dotted format (
.workspace = true) foruniformity with the rest of omicron. This is new in cargo-hakari
0.9.28.
Use a patch directive, which means that the workspace-hack only
applies while building within this workspace. If another workspace
imports a crate from here via a git dependency, it will not have the
workspace-hack applied to it (instead, it will use this empty crate
on crates.io). Thanks so much to @pfmooney for this
suggestion!
Also remove one of the exceptions made in the xtask (workspace-hack
lines in other
Cargo.tomls are now output as.workspace = true,but hakari cannot yet generate workspace lines in its own
Cargo.toml).I verified by creating an empty project that the workspace-hack isn't applied to downstream projects that import e.g.
omicron-commonas a git (or path) dependency.Folks will have to update to cargo-hakari 0.9.28 to use this, but hopefully that won't be too much of a bother.